/*
 *  Copyright 2012-16 ARM Limited and Contributors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    * Neither the name of ARM Limited nor the
 *      names of its contributors may be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY ARM LIMITED AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED. IN NO EVENT SHALL ARM LIMITED AND CONTRIBUTORS BE LIABLE FOR ANY
 *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * NE10 Library : inc/NE10_dsp.h
 */

#include "NE10_types.h"

#ifndef NE10_IIR_H
#define NE10_IIR_H

#ifdef __cplusplus
extern "C" {
#endif

 /**
 * @addtogroup IIR_Lattice
 * @{
 */
extern ne10_result_t ne10_iir_lattice_init_float (ne10_iir_lattice_instance_f32_t * S,
        ne10_uint16_t numStages,
        ne10_float32_t * pkCoeffs,
        ne10_float32_t * pvCoeffs,
        ne10_float32_t * pState,
        ne10_uint32_t blockSize);

/**
 * @brief Processing function for the floating-point IIR lattice filter.
 *
 * @param[in] *S points to an instance of the floating-point IIR lattice structure.
 * @param[in] *pSrc points to the block of input data.
 * @param[out] *pDst points to the block of output data.
 * @param[in] blockSize number of samples to process.
 *
 * Points to @ref ne10_iir_lattice_float_c or @ref ne10_iir_lattice_float_neon.
 */
extern void (*ne10_iir_lattice_float) (const ne10_iir_lattice_instance_f32_t * S,
                                       ne10_float32_t * pSrc,
                                       ne10_float32_t * pDst,
                                       ne10_uint32_t blockSize);

extern void ne10_iir_lattice_float_c (const ne10_iir_lattice_instance_f32_t * S,
                                      ne10_float32_t * pSrc,
                                      ne10_float32_t * pDst,
                                      ne10_uint32_t blockSize);
#ifdef ENABLE_NE10_IIR_LATTICE_FLOAT_NEON
    /**
     * Specific implementation of @ref ne10_iir_lattice_float using NEON SIMD capabilities.
     */
    extern void ne10_iir_lattice_float_neon (const ne10_iir_lattice_instance_f32_t * S,
            ne10_float32_t * pSrc,
            ne10_float32_t * pDst,
            ne10_uint32_t blockSize) asm ("ne10_iir_lattice_float_neon");
#endif // ENABLE_NE10_IIR_LATTICE_FLOAT_NEON
    /** @} */ // IIR_Lattice

#ifdef __cplusplus
}
#endif

#endif
